home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / sre0986g.zip / SRDOOR.DOC < prev    next >
Text File  |  1992-08-16  |  6KB  |  143 lines
  1. ───[SRDOOR 3.1]───────────────────────────────────────────────────────────────
  2.  
  3. Purpose:
  4.          This program reads a BBS door file and converts it into a standard
  5.          Solar Realms format file called DOORFILE.SR.  This one program will
  6.          work with BRE, SRE, SCE, AC6, LEA, PC, SRH, and any other games from
  7.          the Solar Realm.  The purpose of an external door conversion is to
  8.          allow sysops of BBSes not supported by SRDOOR to use another program
  9.          to convert to the DOORFILE.SR file.  For example, if you were
  10.          running a BBS that produced USER.DAT as a door file, and SRDOOR
  11.          did not support it, you could write a program to replace SRDOOR
  12.          that would read USER.DAT and convert it to DOORFILE.SR.  See the
  13.          section, "File Format".
  14.  
  15. Format:
  16.      SRDOOR [«specialbbstype» [«comport»]]
  17.       or
  18.      SRDOOR -f «filename»
  19.  
  20.          The parameters "specialbbstype" and "comport" are required for
  21.          certain BBS types.  See the "File Format" section for more
  22.          information.
  23.  
  24.      The -f option allows you to choose a setup file other than SETUP.SR.
  25.  
  26.          or
  27.  
  28.      (writing the doorfile directly)
  29.  
  30.      ECHO «username»     >DOORFILE.SR
  31.      ECHO «ansi-status»    >>DOORFILE.SR
  32.      ECHO «ibm-char-status» >>DOORFILE.SR
  33.      ECHO «page-length»    >>DOORFILE.SR
  34.      ECHO «baud-rate»    >>DOORFILE.SR
  35.      ECHO «com-port»    >>DOORFILE.SR
  36.      ECHO «time-limit»    >>DOORFILE.SR
  37.  
  38.      For example, if your BBS passes as command line parameters
  39.      the username in %1, the com port in %2, the baud rate in %3,
  40.      and the time limit in %4, but doesn't pass the others, you
  41.      could write into your batch file (instead of SRDOOR):
  42.  
  43.      ECHO %1   >DOORFILE.SR
  44.      ECHO -1  >>DOORFILE.SR
  45.      ECHO -1  >>DOORFILE.SR
  46.      ECHO -1  >>DOORFILE.SR
  47.      ECHO %3  >>DOORFILE.SR
  48.      ECHO %2  >>DOORFILE.SR
  49.      ECHO %4  >>DOORFILE.SR
  50.  
  51.      (The -1 means "I don't know this value"; you can use this for
  52.      ANSI, pagelength, IBM character status, and Time Limit.)
  53.  
  54. Setup:
  55.          Use the INSTALL program to set up a batch file.  It will
  56.          automatically run SRDOOR.
  57.  
  58.          If you have a non-supported BBS, these are some options:
  59.             1.  Use a doorfile converter to convert to a supported format
  60.                 (DOOR.SYS or DORINFO1.DEF preferred)
  61.             2.  Write a program to read your doorfile and write DOORFILE.SR;
  62.                 if you do this, please send us your program so that we may
  63.                 incorporate it into future versions of SRDOOR. (see below)
  64.         3.    Use command-line parameters to write directly to DOORFILE.SR.
  65.         (See above for an example.)
  66.  
  67. Compatibility:
  68.          We have tested SRDOOR with DOOR.SYS and DORINFO1.DEF; we have not
  69.          been able to test it with the other door types.  If you have any
  70.          useful information, please send it to us!  Also, the tests we
  71.          have done were for DOOR.SYS produced by Telegard, not Wildcat,
  72.          software.
  73.  
  74. File Format:
  75.          SRDOOR reads text files in which one piece of information is on
  76.          each line.  Unfortunately, some BBS programs do not create these
  77.          types of door files.  For standard door files, view SETUP.SR for
  78.          more information.  For a non-standard door file, SRDOOR currently
  79.          has experimental GTUSER and PCBOARD modes:
  80.  
  81.             SRDOOR PCBOARD1
  82.                Converts PCBoard 14.x type PCBOARD.SYS files to DOORFILE.SR.
  83.             SRDOOR PCBOARD2 «comport»
  84.                Converts PCBoard 12.1 type PCBOARD.SYS files to DOORFILE.SR.
  85.             SRDOOR GTUSER «comport»
  86.                Converts GT type GTUSER.BBS files to DOORFILE.SR.
  87.  
  88.          Notice that the parameter «comport» is needed in the Old PC-Board
  89.          and GT-USER files.  Use the COM port that the modem is attached to
  90.          (1, 2, 3, or 4).
  91.  
  92.          You can also write your own program to convert your favorite door
  93.          file to DOORFILE.SR.  The DOORFILE.SR format is:
  94.  
  95.             <line 1):   Complete name of user
  96.             (line 2):   ANSI status:  1 = yes, 0 = no, -1 = don't know
  97.             (line 3):   IBM Graphic characters:  1 = yes, 0 = no, -1 = unknown
  98.             (line 4):   Page length of screen, in lines.  Assume 25 if unknown
  99.             (line 5):   Baud Rate:  300, 1200, 2400, 9600, 19200, etc.
  100.             (line 6):   Com Port:  1, 2, 3, or 4.
  101.             (line 7):   Time Limit:  (in minutes); -1 if unknown.
  102.  
  103.          There is a program called GENPC that does this for Genesis Deluxe
  104.          BBS software.
  105.  
  106. Bugs:
  107.          <> Not tested for BBS types other than DOOR.SYS and DORINFO1.DEF.
  108.  
  109.          <> PCBOARD 14.x support not working.
  110.  
  111. Bug Fixes:
  112.          <> 38400 support now FINALLY works!
  113.  
  114. Online Game Writers:
  115.          We at the Solar Realm encourage you to use this door file format.
  116.          We feel it has all the necessary information for a door game.  It
  117.          also has the advantage of being easy to read in a variety of
  118.          languages (unlike many door files being used that require BASIC,
  119.          Pascal, or C).  By using an external door conversion program, you
  120.          leave open the option for sysops to write their own converter so that
  121.          those sysops who have BBSes that your game does not support may be
  122.          able to find or write a replacement for SRDOOR.
  123.  
  124. Contact:
  125.          For more information, contact the Solar Realm BBS at (713)855-1665.
  126.          (19.2k USR/DS.; 1:106/900 fido)
  127.  
  128. Disclaimer:
  129.          This program is not guaranteed to work.  It is distributed "as-is".
  130.          If you find it useful, great!  If not, we are in no way to be held
  131.          responsible.  No contribution is required to use this program.  It
  132.          is meant to be used with Solar Realms door programs.
  133.  
  134. Usage:
  135.          If any person wishes to use this program for any other legal use,
  136.          the only requirement is that she or he write a letter to the Solar
  137.          Realm BBS informing them that SRDOOR is being used.  Please describe
  138.          your project.  We are interested in keeping track of all persons
  139.          using SRDOOR (for upgrade notices and information purposes).  No
  140.          charge is required to use SRDOOR, and no fee may be charged for its
  141.          distribution.  This documentation file must accompany SRDOOR.
  142.  
  143.